Node / public / reticulum / files / docs / source / conf.py

Displaying Raw • Download

T8b949e# Configuration file for the Sphinx documentation builder.

T8b949e#

T8b949e# This file only contains a selection of the most common options. For a full

T8b949e# list see the documentation:

T8b949e# https://www.sphinx-doc.org/en/master/usage/configuration.html

T8b949e# -- Path setup --------------------------------------------------------------

T8b949e# If extensions (or modules to document with autodoc) are in another directory,

T8b949e# add these directories to sys.path here. If the directory is relative to the

T8b949e# documentation root, use os.path.abspath to make it absolute, like shown here.

T8b949e#

Tff7b72import T7ee787os

Tff7b72import T7ee787sys

Te6edf3sysTff7b72.Td2a8ffpathTff7b72.Td2a8ffinsertTb4b4b4(T79c0ff0Tb4b4b4, Te6edf3osTff7b72.Td2a8ffpathTff7b72.Td2a8ffabspathTb4b4b4(Ta5d6ff'Ta5d6ff../..Ta5d6ff'Tb4b4b4)Tb4b4b4)

T8b949e# -- Project information -----------------------------------------------------

Te6edf3project Tff7b72= Ta5d6ff'Ta5d6ffReticulum Network StackTa5d6ff'

Te6edf3copyright Tff7b72= Ta5d6ff'Ta5d6ff2021, Mark QvistTa5d6ff'

Te6edf3author Tff7b72= Ta5d6ff'Ta5d6ffMark QvistTa5d6ff'

T8b949e# The full version, including alpha/beta/rc tags

Te6edf3release Tff7b72= Ta5d6ff'Ta5d6ff0.2.4 betaTa5d6ff'

T8b949e# -- General configuration ---------------------------------------------------

T8b949e# Add any Sphinx extension module names here, as strings. They can be

T8b949e# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

T8b949e# ones.

Te6edf3extensions Tff7b72= Tb4b4b4[

Ta5d6ff'Ta5d6ffsphinx.ext.autodocTa5d6ff'Tb4b4b4,

T8b949e#'sphinx.ext.autosectionlabel',

Tb4b4b4]

Te6edf3autodoc_member_order Tff7b72= Ta5d6ff'Ta5d6ffbysourceTa5d6ff'

T8b949e#latex_toplevel_sectioning = 'section'

T8b949e# Add any paths that contain templates here, relative to this directory.

Te6edf3templates_path Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ff_templatesTa5d6ff'Tb4b4b4]

T8b949e# List of patterns, relative to source directory, that match files and

T8b949e# directories to ignore when looking for source files.

T8b949e# This pattern also affects html_static_path and html_extra_path.

Te6edf3exclude_patterns Tff7b72= Tb4b4b4[Tb4b4b4]

T8b949e# -- Options for HTML output -------------------------------------------------

T8b949e# The theme to use for HTML and HTML Help pages. See the documentation for

T8b949e# a list of builtin themes.

T8b949e#

Te6edf3html_theme Tff7b72= Ta5d6ff'Ta5d6ffclassicTa5d6ff'

T8b949e# Add any paths that contain custom static files (such as style sheets) here,

T8b949e# relative to this directory. They are copied after the builtin static files,

T8b949e# so a file named "default.css" will overwrite the builtin "default.css".

Te6edf3html_static_path Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ff_staticTa5d6ff'Tb4b4b4]

T8b949e# def check_skip_member(app, what, name, obj, skip, options):

T8b949e# print(what, " | ", name, " | ", obj, " | ", skip, " | ", options)

T8b949e# return False

T8b949e# def setup(app):

T8b949e# app.connect('autodoc-skip-member', check_skip_member)